feat(replay): Capture network request/response details when using SentryOkHttpListener #4919

43jay · 2025-11-19T19:30:44Z

📜 Description

Make network details capture (http request/response bodies and headers - docs) available to clients using the sentry gradle plugin by adding support to SentryOkHttpEventListener.

Updates CHANGELOG.

💡 Motivation and Context

Part of [Mobile Replay] Capture Network request/response bodies.

Network Details extraction depends on okhttp3.Interceptor (SentryOkHttpInterceptor) to intercept okhttp requests and extract the relevant data to the Breadcrumb Hint (see #4796).

However, the Sentry Interceptor is only responsible for sending Breadcrumb data if for some reason the SentryOkHttpEventListener is not used (code ref).

Given registering SentryOkHttpEventListener is the default gradle plugin behavior, typical SDK configuration will see Breadcrumb data sent via SentryOkHttpEventListener. So this PR modifies SentryOkHttpEvent to receive network details data from the interceptor, to be included when sending the Breadcrumb from that path.

💚 How did you test it?

Unit

% ./gradlew :sentry-okhttp:test --tests="*SentryOkHttpEventTest*network*details*"

SentryOkHttpEventTest > when setNetworkDetails is not called, no network details data is captured PASSED

SentryOkHttpEventTest > when finish is called, the breadcrumb sent includes network details data on its hint PASSED

Manual

Build sentry-samples:
% ./gradlew :sentry-okhttp:clean :sentry-android-replay:clean :sentry-samples:sentry-samples-android:clean :sentry-samples:sentry-samples-android:installDebug --no-build-cache --rerun-tasks

1. OkHttpClient w/ Sentry Interceptor+EventListener will upload network details

Modify sentry-samples to create http requests with event listener & interceptor:

Verify session replay created as expected
https://sentry-sdks.sentry.io/explore/replays/09681100b32640b99f53fc68a016f00d/...

2. OKHttpClient w/ only Sentry Interceptor will upload network details

Comment out addEventListener line and rebuild/install:

Verify session replay created as expected
https://sentry-sdks.sentry.io/explore/replays/29ce82bbd31c482e9fb0a60122412d3d/...

3. OKHttpClient w/ NO Sentry Interceptor will NOT upload network details

Comment out addInterceptor line and rebuild/install:

Verify session replay created with no data as expected
https://sentry-sdks.sentry.io/explore/replays/1232a6f76a6e428281779e8021943429/...

📝 Checklist

I added tests to verify the changes. 2 new unit tests in SentryOkHttpEventTest
I added GH Issue ID & Linear ID
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled. N/A
No breaking change or entry added to the changelog. see CHANGELOG.md in this PR
No breaking change for hybrid SDKs or communicated to hybrid SDKs. No sentry.api changes here
Review from the native team if needed. No native changes
Confirm that the gradle plugin always registers SentryOkHttpInterceptor confirmed

🔮 Next steps

I updated the docs if needed. Need docs PR
I updated the wizard if needed. Need wizard update PR

linear · 2025-11-19T19:30:47Z

MOBILE-935 [Mobile Replay] Capture Network request/response bodies

github-actions · 2025-11-19T19:31:23Z

	Fails
🚫	Please consider adding a changelog entry for the next release.

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Instructions and example for changelog

Please add an entry to CHANGELOG.md to the "Unreleased" section. Make sure the entry includes this PR's number.

Example:

## Unreleased

### Features

- Capture network request/response details when using SentryOkHttpListener ([#4919](https://github.com/getsentry/sentry-java/pull/4919))

If none of the above apply, you can opt out of this check by adding #skip-changelog to the PR description or adding a skip-changelog label.

Generated by 🚫 dangerJS against 050c3a6

github-actions · 2025-11-19T19:38:44Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	341.45 ms	406.52 ms	65.07 ms
Size	1.58 MiB	2.13 MiB	557.32 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`604a261`	380.65 ms	451.27 ms	70.62 ms
`ee747ae`	382.73 ms	435.41 ms	52.68 ms
`b77456b`	393.26 ms	441.10 ms	47.84 ms
`9fbb112`	401.87 ms	515.87 ms	114.00 ms
`806307f`	357.85 ms	424.64 ms	66.79 ms
`27d7cf8`	309.43 ms	364.27 ms	54.85 ms
`7314dbe`	437.83 ms	505.64 ms	67.81 ms
`d217708`	375.27 ms	415.68 ms	40.41 ms
`96449e8`	361.30 ms	423.39 ms	62.09 ms
`1df7eb6`	397.04 ms	429.64 ms	32.60 ms

App size

Revision	Plain	With Sentry	Diff
`604a261`	1.58 MiB	2.10 MiB	533.42 KiB
`ee747ae`	1.58 MiB	2.10 MiB	530.95 KiB
`b77456b`	1.58 MiB	2.12 MiB	548.11 KiB
`9fbb112`	1.58 MiB	2.11 MiB	539.18 KiB
`806307f`	1.58 MiB	2.10 MiB	533.42 KiB
`27d7cf8`	1.58 MiB	2.12 MiB	549.42 KiB
`7314dbe`	1.58 MiB	2.10 MiB	533.45 KiB
`d217708`	1.58 MiB	2.10 MiB	532.97 KiB
`96449e8`	1.58 MiB	2.11 MiB	539.35 KiB
`1df7eb6`	1.58 MiB	2.10 MiB	532.97 KiB

Previous results on branch: 43jay/MOBILE-935

Startup times

Revision	Plain	With Sentry	Diff
`fedc731`	325.81 ms	383.02 ms	57.21 ms
`da92356`	319.12 ms	388.73 ms	69.61 ms
`154fb27`	336.98 ms	387.10 ms	50.12 ms
`55850ea`	370.79 ms	431.33 ms	60.55 ms
`3162f1d`	308.61 ms	367.50 ms	58.89 ms
`790a163`	339.64 ms	436.57 ms	96.94 ms
`1c4ba0c`	302.22 ms	367.21 ms	64.98 ms
`6687052`	321.98 ms	383.35 ms	61.38 ms
`1a07f53`	341.15 ms	378.86 ms	37.71 ms

App size

Revision	Plain	With Sentry	Diff
`fedc731`	1.58 MiB	2.13 MiB	557.33 KiB
`da92356`	1.58 MiB	2.13 MiB	556.24 KiB
`154fb27`	1.58 MiB	2.13 MiB	557.32 KiB
`55850ea`	1.58 MiB	2.13 MiB	557.31 KiB
`3162f1d`	1.58 MiB	2.13 MiB	557.32 KiB
`790a163`	1.58 MiB	2.12 MiB	553.01 KiB
`1c4ba0c`	1.58 MiB	2.13 MiB	556.34 KiB
`6687052`	1.58 MiB	2.13 MiB	556.25 KiB
`1a07f53`	1.58 MiB	2.12 MiB	553.02 KiB

cursor

Bug: Duplicate HTTP headers lost in conversion

The toMap() function loses duplicate HTTP headers with the same name. When iterating through OkHttp headers and inserting into a Map<String, String>, duplicate header names get overwritten, keeping only the last value. This causes data loss for headers like Set-Cookie, Accept, or Vary that commonly appear multiple times in HTTP messages. The captured network details will be incomplete when responses or requests contain duplicate headers.

sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt#L265-L272

sentry-java/sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt

Lines 265 to 272 in 22bb832

    
           /** Extracts headers from OkHttp Headers object into a map */ 
        
           private fun okhttp3.Headers.toMap(): Map<String, String> { 
        
             val headers = linkedMapOf<String, String>() 
        
             for (i in 0 until size) { 
        
               headers[name(i)] = value(i) 
        
             } 
        
             return headers 
        
           }

sentry/src/main/java/io/sentry/util/network/NetworkDetailCaptureUtils.java

Run tests ./gradlew :sentry:test --tests="*NetworkDetailCaptureUtilsTest*"

Reuse existing logic that retrieves optional SentryOkHttpEvent for the okhttp3.Call, and optionally provide NetworkRequestData for adding to Breadcrumb Hint in SentryOkHttpEvent#finish

./gradlew :sentry-okhttp:test --tests="*SentryOkHttpEventTest*setNetworkDetails*"

review comment - https://github.com/getsentry/sentry-java/pull/4919/files#r2550496731 seems possible, e.g. if a client passes null in the array to SentryReplayOptions#set[Request|Response]Headers

review comment - #4919 (review) ./gradlew :sentry-okhttp:test --tests="*SentryOkHttpInterceptorTest.toMap handles duplicate headers correctly*"

43jay · 2025-11-21T21:52:50Z

Bug: Duplicate HTTP headers lost in conversion

The toMap() function loses duplicate HTTP headers with the same name. When iterating through OkHttp headers and inserting into a Map<String, String>, duplicate header names get overwritten, keeping only the last value. This causes data loss for headers like Set-Cookie, Accept, or Vary that commonly appear multiple times in HTTP messages. The captured network details will be incomplete when responses or requests contain duplicate headers.

fixed

cursor · 2025-11-21T21:55:36Z

sentry-okhttp/src/main/java/io/sentry/okhttp/SentryOkHttpInterceptor.kt

+        headers[name] = "$existingValue, $value"
+      } else {
+        headers[name] = value
+      }


Bug: Set-Cookie headers incorrectly concatenated with comma separator

The toMap() function concatenates duplicate HTTP headers with comma separators, but Set-Cookie is an exception that cannot be concatenated this way per RFC 6265. Cookie values can contain commas in attributes like expiration dates, causing the concatenated value to become unparseable. This corrupts Set-Cookie headers when multiple cookies are set, breaking network detail capture for session replay.

…ator Issue is that commas are valid separators in certain headers (Cookie, Set-Cookie,...). Switch to semi-colon separated instead -> this only governs the formatted list that appears in the sentry dashboard so is relatively minor. review comment - #4919 (comment) ./gradlew :sentry-okhttp:test --tests="*SentryOkHttpInterceptorTest.toMap handles duplicate headers correctly*"

43jay requested review from adinauer, lcian, markushi, romtsn and stefanosiano as code owners November 19, 2025 19:30

43jay marked this pull request as draft November 19, 2025 19:31

43jay force-pushed the 43jay/MOBILE-935 branch from cf95f21 to 2e9b796 Compare November 19, 2025 19:44

43jay marked this pull request as ready for review November 19, 2025 20:09

cursor bot reviewed Nov 19, 2025

View reviewed changes

cursor bot reviewed Nov 21, 2025

View reviewed changes

sentry/src/main/java/io/sentry/util/network/NetworkDetailCaptureUtils.java Show resolved Hide resolved

43jay changed the title ~~[android] Capture network request/response details when using SentryOkHttpListener~~ feat(replay): Capture network request/response details when using SentryOkHttpListener Nov 21, 2025

43jay and others added 5 commits November 21, 2025 16:43

Use case-insensitive comparision when extracting headers

b5ea38f

Run tests ./gradlew :sentry:test --tests="*NetworkDetailCaptureUtilsTest*"

Extract network details when using SentryOkHttpEventListener

5841544

Reuse existing logic that retrieves optional SentryOkHttpEvent for the okhttp3.Call, and optionally provide NetworkRequestData for adding to Breadcrumb Hint in SentryOkHttpEvent#finish

CHANGELOG for Network Details extraction

5dc9fab

unit tests

9016498

./gradlew :sentry-okhttp:test --tests="*SentryOkHttpEventTest*setNetworkDetails*"

Format code

e6d7289

43jay force-pushed the 43jay/MOBILE-935 branch from e9a9f5f to e6d7289 Compare November 21, 2025 20:43

43jay added 2 commits November 21, 2025 16:52

bug: fix NullPointerException if allowedHeaders contains null

4b30647

review comment - https://github.com/getsentry/sentry-java/pull/4919/files#r2550496731 seems possible, e.g. if a client passes null in the array to SentryReplayOptions#set[Request|Response]Headers

bug: fix Duplicate HTTP headers lost in conversion

af6765d

review comment - #4919 (review) ./gradlew :sentry-okhttp:test --tests="*SentryOkHttpInterceptorTest.toMap handles duplicate headers correctly*"

cursor bot reviewed Nov 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(replay): Capture network request/response details when using SentryOkHttpListener #4919

feat(replay): Capture network request/response details when using SentryOkHttpListener #4919

Uh oh!

43jay commented Nov 19, 2025 •

edited

Loading

Uh oh!

linear bot commented Nov 19, 2025

Uh oh!

github-actions bot commented Nov 19, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Nov 19, 2025 •

edited

Loading

Baseline results on branch: main

Startup times

App size

Previous results on branch: 43jay/MOBILE-935

Startup times

App size

Uh oh!

cursor bot left a comment

Uh oh!

Uh oh!

43jay commented Nov 21, 2025

Bug: Duplicate HTTP headers lost in conversion

Uh oh!

cursor bot Nov 21, 2025

Uh oh!

43jay Nov 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	/** Extracts headers from OkHttp Headers object into a map */
	private fun okhttp3.Headers.toMap(): Map<String, String> {
	val headers = linkedMapOf<String, String>()
	for (i in 0 until size) {
	headers[name(i)] = value(i)
	}
	return headers
	}

Uh oh!

feat(replay): Capture network request/response details when using SentryOkHttpListener #4919

Are you sure you want to change the base?

feat(replay): Capture network request/response details when using SentryOkHttpListener #4919

Uh oh!

Conversation

43jay commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📜 Description

💡 Motivation and Context

💚 How did you test it?

Unit

Manual

📝 Checklist

🔮 Next steps

Uh oh!

linear bot commented Nov 19, 2025

Uh oh!

github-actions bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Instructions and example for changelog

Uh oh!

github-actions bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: 43jay/MOBILE-935

Startup times

App size

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Duplicate HTTP headers lost in conversion

Uh oh!

Uh oh!

43jay commented Nov 21, 2025

Bug: Duplicate HTTP headers lost in conversion

Uh oh!

cursor bot Nov 21, 2025

Choose a reason for hiding this comment

Bug: Set-Cookie headers incorrectly concatenated with comma separator

Uh oh!

43jay Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

43jay commented Nov 19, 2025 •

edited

Loading

github-actions bot commented Nov 19, 2025 •

edited

Loading

github-actions bot commented Nov 19, 2025 •

edited

Loading